Resource URL: /platform/<<version=1>>/auth/providers/nis/<ID>

    Overview: This resource applies the standard collection pattern to
              individual NIS providers.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the NIS provider.

       URL: GET /platform/<<version=1>>/auth/providers/nis/<ID>

Query arguments:
scope=<enum> Where <enum> is one of user, default, effective.  If specified as
             "effective" or not specified, all fields are returned.  If
             specified as "user", only fields with non-default values are
             shown.  If specified as "default", the original values are
             returned.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "nis": {
      "items": {
        "type": "object", 
        "description": "Specifies the properties for an NIS authentication provider.", 
        "properties": {
          "hostname_lookup": {
            "type": "boolean", 
            "description": "If true, enables host name look ups."
          }, 
          "group_domain": {
            "type": "string", 
            "description": "Specifies the domain for this provider through which groups are qualified."
          }, 
          "servers": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Adds an NIS server for this provider."
          }, 
          "unlistable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies a user that cannot be listed by the provider."
          }, 
          "normalize_users": {
            "type": "boolean", 
            "description": "Normalizes user names to lowercase before look up."
          }, 
          "id": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the NIS provider ID."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "request_timeout": {
            "type": "integer", 
            "description": "Specifies the request timeout interval in seconds."
          }, 
          "provider_domain": {
            "type": "string", 
            "description": "Specifies the domain for the provider."
          }, 
          "enumerate_groups": {
            "type": "boolean", 
            "description": "If true, allows the provider to enumerate groups."
          }, 
          "listable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the groups that can be viewed in the provider."
          }, 
          "system": {
            "type": [
              {
                "type": "boolean", 
                "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "authentication": {
            "type": "boolean", 
            "description": "If true, enables authentication and identity management through the authentication provider."
          }, 
          "restrict_findable": {
            "type": "boolean", 
            "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
          }, 
          "status": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the status of the provider."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "login_shell": {
            "type": "string", 
            "description": "Specifies the login shell path."
          }, 
          "home_directory_template": {
            "type": "string", 
            "description": "Specifies the path to the home directory template."
          }, 
          "findable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the list of users that can be resolved."
          }, 
          "nis_domain": {
            "type": "string", 
            "description": "Specifies the NIS domain name."
          }, 
          "unfindable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies groups that cannot be resolved by the provider."
          }, 
          "enumerate_users": {
            "type": "boolean", 
            "description": "If true, allows the provider to enumerate users."
          }, 
          "retry_time": {
            "type": "integer", 
            "description": "Specifies the timeout period in seconds after which a request will be retried."
          }, 
          "normalize_groups": {
            "type": "boolean", 
            "description": "Normalizes group names to lowercase before look up."
          }, 
          "ypmatch_using_tcp": {
            "type": "boolean", 
            "description": "If true, specifies TCP for YP Match operations."
          }, 
          "user_domain": {
            "type": "string", 
            "description": "Specifies the domain for this provider through which users are qualified."
          }, 
          "name": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the NIS provider name."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "listable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the users that can be viewed in the provider."
          }, 
          "unlistable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies a group that cannot be listed by the provider."
          }, 
          "balance_servers": {
            "type": "boolean", 
            "description": "If true, connects the provider to a random server."
          }, 
          "enabled": {
            "type": "boolean", 
            "description": "If true, enables the NIS provider."
          }, 
          "check_online_interval": {
            "type": "integer", 
            "description": "Specifies the time in seconds between provider online checks."
          }, 
          "unfindable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies users that cannot be resolved by the provider."
          }, 
          "findable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the list of groups that can be resolved."
          }, 
          "restrict_listable": {
            "type": "boolean", 
            "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups."
          }, 
          "ntlm_support": {
            "enum": [
              "all", 
              "v2only", 
              "none"
            ], 
            "type": "string", 
            "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials."
          }, 
          "create_home_directory": {
            "type": "boolean", 
            "description": "Automatically creates the home directory on the first login."
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify the NIS provider.

       URL: PUT /platform/<<version=1>>/auth/providers/nis/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for an NIS authentication provider.", 
  "properties": {
    "hostname_lookup": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, enables host name look ups."
        }
      ]
    }, 
    "group_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the domain for this provider through which groups are qualified."
        }
      ]
    }, 
    "servers": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Adds an NIS server for this provider."
        }
      ]
    }, 
    "unlistable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies a user that cannot be listed by the provider."
        }
      ]
    }, 
    "normalize_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Normalizes user names to lowercase before look up."
        }
      ]
    }, 
    "request_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Specifies the request timeout interval in seconds."
        }
      ]
    }, 
    "provider_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the domain for the provider."
        }
      ]
    }, 
    "enumerate_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allows the provider to enumerate groups."
        }
      ]
    }, 
    "listable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the groups that can be viewed in the provider."
        }
      ]
    }, 
    "authentication": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, enables authentication and identity management through the authentication provider."
        }
      ]
    }, 
    "restrict_findable": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
        }
      ]
    }, 
    "login_shell": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the login shell path."
        }
      ]
    }, 
    "home_directory_template": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the path to the home directory template."
        }
      ]
    }, 
    "findable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the list of users that can be resolved."
        }
      ]
    }, 
    "nis_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the NIS domain name."
        }
      ]
    }, 
    "unfindable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies groups that cannot be resolved by the provider."
        }
      ]
    }, 
    "enumerate_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allows the provider to enumerate users."
        }
      ]
    }, 
    "retry_time": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Specifies the timeout period in seconds after which a request will be retried."
        }
      ]
    }, 
    "normalize_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Normalizes group names to lowercase before look up."
        }
      ]
    }, 
    "ypmatch_using_tcp": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, specifies TCP for YP Match operations."
        }
      ]
    }, 
    "user_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the domain for this provider through which users are qualified."
        }
      ]
    }, 
    "name": {
      "type": "string", 
      "description": "Specifies the NIS provider name."
    }, 
    "listable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the users that can be viewed in the provider."
        }
      ]
    }, 
    "unlistable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies a group that cannot be listed by the provider."
        }
      ]
    }, 
    "balance_servers": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, connects the provider to a random server."
        }
      ]
    }, 
    "enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, enables the NIS provider."
        }
      ]
    }, 
    "check_online_interval": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Specifies the time in seconds between provider online checks."
        }
      ]
    }, 
    "unfindable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies users that cannot be resolved by the provider."
        }
      ]
    }, 
    "findable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the list of groups that can be resolved."
        }
      ]
    }, 
    "restrict_listable": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups."
        }
      ]
    }, 
    "ntlm_support": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "all", 
            "v2only", 
            "none"
          ], 
          "type": "string", 
          "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials."
        }
      ]
    }, 
    "create_home_directory": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Automatically creates the home directory on the first login."
        }
      ]
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete the NIS provider.

          URL: DELETE /platform/<<version=1>>/auth/providers/nis/<ID>

There are no query arguments for this method.

There is no response body for this method.
